/*
 * Copyright (c) 2024-2025.  little3201.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *       https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.leafage.exploiter.service;


import io.leafage.exploiter.dto.SchemaDTO;
import io.leafage.exploiter.vo.RenderedMasterPlateVO;
import io.leafage.exploiter.vo.SchemaVO;
import org.springframework.data.domain.Page;
import top.leafage.common.servlet.ServletBasicService;

import java.util.List;
import java.util.zip.ZipOutputStream;

/**
 * schema service.
 *
 * @author wq li
 */
public interface SchemaService extends ServletBasicService<SchemaDTO, SchemaVO> {

    /**
     * Retrieves a paginated list of records.
     *
     * @param page   The page number (zero-based).
     * @param size   The number of records per page.
     * @param connectionId The field filter.
     * @return A paginated list of records.
     */
    Page<SchemaVO> retrieve(int page, int size, Long connectionId);

    /**
     * Generates a template.
     *
     * @param id  The primary key of the template.
     * @param zos The output stream to write the generated template.
     */
    void generate(Long id, ZipOutputStream zos);

    /**
     * Previews the template.
     *
     * @param id The primary key of the template.
     * @return A list of template value objects.
     */
    List<RenderedMasterPlateVO> preview(Long id);

    /**
     * Synchronizes the template.
     *
     * @param id The primary key of the template.
     */
    void sync(Long id);

}
